Spot-On
spot-on-misc.h
1 /*
2 ** Copyright (c) 2011 - 10^10^10, Alexis Megas.
3 ** All rights reserved.
4 **
5 ** Redistribution and use in source and binary forms, with or without
6 ** modification, are permitted provided that the following conditions
7 ** are met:
8 ** 1. Redistributions of source code must retain the above copyright
9 ** notice, this list of conditions and the following disclaimer.
10 ** 2. Redistributions in binary form must reproduce the above copyright
11 ** notice, this list of conditions and the following disclaimer in the
12 ** documentation and/or other materials provided with the distribution.
13 ** 3. The name of the author may not be used to endorse or promote products
14 ** derived from Spot-On without specific prior written permission.
15 **
16 ** SPOT-ON IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 ** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 ** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 ** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 ** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 ** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 ** SPOT-ON, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 
28 #ifndef _spoton_misc_h_
29 #define _spoton_misc_h_
30 
31 #include <QAtomicInt>
32 #if QT_VERSION >= 0x050501 && defined(SPOTON_BLUETOOTH_ENABLED)
33 #include <QBluetoothAddress>
34 #endif
35 #include <QHostAddress>
36 #include <QPair>
37 #include <QReadWriteLock>
38 #include <QSqlDatabase>
39 #include <QString>
40 #include <QVariant>
41 
42 #if defined(Q_OS_WIN)
43 extern "C"
44 {
45 #include <winsock2.h>
46 #include <ws2tcpip.h>
47 }
48 #else
49 extern "C"
50 {
51 #include <netinet/in.h>
52 #include <sys/socket.h>
53 }
54 #endif
55 
56 /*
57 ** Please read https://gcc.gnu.org/onlinedocs/gcc-4.4.1/gcc/Optimize-Options.html#Type_002dpunning.
58 */
59 
61 {
62  struct sockaddr sockaddr;
63  struct sockaddr_in sockaddr_in;
64  struct sockaddr_in6 sockaddr_in6;
65  struct sockaddr_storage sockaddr_storage;
66 }
68 
69 class QTcpSocket;
70 class spoton_crypt;
71 
73 {
74  public:
75  static QByteArray findPublicKeyHashGivenHash(const QByteArray &randomBytes,
76  const QByteArray &hash,
77  const QByteArray &hashKey,
78  const QByteArray &haskType,
79  spoton_crypt *crypt);
80  static QByteArray forwardSecrecyMagnetFromList
81  (const QList<QByteArray> &list);
82  static QByteArray publicKeyFromHash(const QByteArray &publicKeyHash,
83  const bool gpg,
84  spoton_crypt *crypt);
85  static QByteArray publicKeyFromOID(const qint64 oid, spoton_crypt *crypt);
86  static QByteArray publicKeyFromSignaturePublicKeyHash
87  (const QByteArray &signaturePublicKeyHash, spoton_crypt *crypt);
88  static QByteArray signaturePublicKeyFromPublicKeyHash
89  (const QByteArray &publicKeyHash, spoton_crypt *crypt);
90  static QByteArray urlToEncoded(const QUrl &url);
91  static QByteArray wrap(const QByteArray &data, const int c = 80);
92  static QByteArray xor_arrays(const QByteArray &a, const QByteArray &b);
93  static QHash<QString, QByteArray> retrieveEchoShareInformation
94  (const QString &communityName, spoton_crypt *crypt);
95  static QHostAddress localAddressIPv4(void);
96  static QHostAddress peerAddressAndPort(
97 #if defined(Q_OS_WIN)
98  const SOCKET socketDescriptor,
99 #else
100  const int socketDescriptor,
101 #endif
102  quint16 *port);
103  static QList<QByteArray> findEchoKeys(const QByteArray &bytes1,
104  const QByteArray &bytes2,
105  QString &type,
106  spoton_crypt *crypt);
107  static QList<QByteArray> findForwardSecrecyKeys(const QByteArray &bytes1,
108  const QByteArray &bytes2,
109  QString &messageType,
110  spoton_crypt *crypt);
111  static QList<QHash<QString, QVariant> > poptasticSettings
112  (const QString &in_username, spoton_crypt *crypt, bool *ok);
113  static QMap<QString, QVariant> otherOptions(const QByteArray &bytes);
114  static QPair<QByteArray, QByteArray> decryptedAdaptiveEchoPair
115  (const QPair<QByteArray, QByteArray> &pair, spoton_crypt *crypt);
116  static QPair<QByteArray, QByteArray> findGeminiInCosmos
117  (const QByteArray &data, const QByteArray &hash, spoton_crypt *crypt);
118  static QSqlDatabase database(QString &connectionName);
119  static QString adjustPQConnectOptions(const QString &s);
120  static QString countryCodeFromIPAddress(const QString &ipAddress);
121  static QString countryNameFromIPAddress(const QString &ipAddress);
122  static QString databaseName(void);
123  static QString formattedSize(const qint64 size);
124  static QString homePath(void);
125  static QString htmlEncode(const QString &string);
126  static QString keyTypeFromPublicKeyHash(const QByteArray &publicKeyHash,
127  spoton_crypt *crypt);
128  static QString massageIpForUi(const QString &ip, const QString &protocol);
129  static QString nameFromPublicKeyHash(const QByteArray &publicKeyHash,
130  spoton_crypt *crypt);
131  static QString percentEncoding(const QString &string);
132  static QString prettyFileSize(const qint64 size);
133  static QString removeSpecialHtmlTags(const QString &text);
134  static QString wrap(const QString &t, const int c = 80);
135  static bool acceptableTimeSeconds(const QDateTime &then, const int delta);
136  static bool allParticipantsHaveGeminis(void);
137  static bool authenticateAccount(QByteArray &name,
138  QByteArray &password,
139  const qint64 listenerOid,
140  const QByteArray &saltedCredentials,
141  const QByteArray &salt,
142  spoton_crypt *crypt);
143  static bool importUrl(const QByteArray &c, // Content
144  const QByteArray &d, // Description
145  const QByteArray &t, // Title
146  const QByteArray &u, // URL
147  const QSqlDatabase &db,
148  const int maximum_keywords,
149  const bool disable_synchronous_sqlite_writes,
150  QAtomicInt &atomic,
151  QString &error,
152  spoton_crypt *crypt);
153  static bool isAcceptedIP(const QHostAddress &address,
154  const qint64 id,
155  spoton_crypt *crypt);
156  static bool isAcceptedIP(const QString &address,
157  const qint64 id,
158  spoton_crypt *crypt);
159  static bool isAcceptedParticipant(const QByteArray &publicKeyHash,
160  const QString &keyType,
161  spoton_crypt *crypt);
162  static bool isAuthenticatedHint(spoton_crypt *crypt);
163  static bool isIpBlocked(const QHostAddress &address,
164  spoton_crypt *crypt);
165  static bool isIpBlocked(const QString &address,
166  spoton_crypt *crypt);
167  static bool isMulticastAddress(const QHostAddress &address);
168  static bool isPrivateNetwork(const QHostAddress &address);
169  static bool isValidBuzzMagnet(const QByteArray &magnet);
170  static bool isValidBuzzMagnetData(const QByteArray &data);
171  static bool isValidForwardSecrecyMagnet(const QByteArray &magnet,
172  QList<QByteArray> &values);
173  static bool isValidInstitutionMagnet(const QByteArray &magnet);
174  static bool isValidSMPMagnet(const QByteArray &magnet,
175  QList<QByteArray> &values);
176  static bool isValidSignature(const QByteArray &data,
177  const QByteArray &publicKeyHash,
178  const QByteArray &signature,
179  spoton_crypt *crypt);
180  static bool isValidStarBeamMagnet(const QByteArray &magnet);
181  static bool joinMulticastGroup(const QHostAddress &address,
182  const QVariant &loop,
183 #if defined(Q_OS_WIN)
184  const SOCKET socketDescriptor,
185 #else
186  const int socketDescriptor,
187 #endif
188  const quint16 port);
189  static bool prepareUrlDistillersDatabase(void);
190  static bool prepareUrlKeysDatabase(void);
191  static bool publicKeyExists(const qint64 oid);
192  static bool saveFriendshipBundle(const QByteArray &keyType,
193  const QByteArray &name,
194  const QByteArray &publicKey,
195  const QByteArray &sPublicKey,
196  const qint64 neighborOid,
197  const QSqlDatabase &db,
198  spoton_crypt *crypt,
199  const bool useKeyTypeForName = true);
200  static bool saveGemini(const QPair<QByteArray, QByteArray> &gemini,
201  const QString &oid,
202  spoton_crypt *crypt);
203  static bool saveReceivedStarBeamHashes(const QSqlDatabase &db,
204  const QByteArray &hash1,
205  const QByteArray &hash2,
206  const QString &oid,
207  spoton_crypt *crypt);
208  static bool storeAlmostAnonymousLetter(const QList<QByteArray> &list,
209  spoton_crypt *crypt);
210  static int minimumNeighborLaneWidth(void);
211  static qint64 oidFromPublicKeyHash(const QByteArray &publicKeyHash);
212  static qint64 participantCount(const QString &keyType,
213  spoton_crypt *crypt);
214  static qint64 sendQueueSize(QTcpSocket *socket);
215  static quint64 databaseAccesses(void);
216  static spoton_crypt *cryptFromForwardSecrecyMagnet
217  (const QByteArray &magnet);
218  static spoton_crypt *parsePrivateApplicationMagnet(const QByteArray &magnet);
219  static spoton_crypt *retrieveUrlCommonCredentials(spoton_crypt *crypt);
220  static void alterDatabasesAfterAuthentication(spoton_crypt *crypt);
221  static void cleanupDatabases(spoton_crypt *crypt);
222  static void closeSocket(const qintptr socketDescriptor);
223  static void correctSettingsContainer(QHash<QString, QVariant> settings);
224  static void enableLog(const bool state);
225  static void logError(const QString &error);
226  static void populateUrlsDatabase(const QList<QList<QVariant> > &list,
227  spoton_crypt *crypt);
228  static void prepareAuthenticationHint(spoton_crypt *crypt);
229  static void prepareDatabases(void);
230  static void prepareSignalHandler(void (*signal_handler) (int));
231  static void purgeSignatureRelationships(const QSqlDatabase &db,
232  spoton_crypt *crypt);
233  static void removeOneTimeStarBeamMagnets(void);
234  static void retrieveSymmetricData(QPair<QByteArray, QByteArray> &gemini,
235  QByteArray &publicKey,
236  QByteArray &symmetricKey,
237  QByteArray &hashKey,
238  QByteArray &startsWith,
239  QString &neighborOid,
240  QString &receiverName,
241  const QByteArray &cipherType,
242  const QString &oid,
243  spoton_crypt *crypt,
244  bool *ok);
245  static void saveParticipantStatus(const QByteArray &name,
246  const QByteArray &publicKeyHash,
247  const QByteArray &status,
248  const QByteArray &timestamp,
249  const int seconds,
250  spoton_crypt *crypt);
251 #if QT_VERSION >= 0x050501 && defined(SPOTON_BLUETOOTH_ENABLED)
252  static void savePublishedNeighbor(const QBluetoothAddress &address,
253  const quint16 port,
254  const QString &statusControl,
255  const QString &orientation,
256  spoton_crypt *crypt);
257 #endif
258  static void savePublishedNeighbor(const QHostAddress &address,
259  const quint16 port,
260  const QString &transport,
261  const QString &statusControl,
262  const QString &orientation,
263  spoton_crypt *crypt);
264  static void setTimeVariables(const QHash<QString, QVariant> &settings);
265  static void vacuumAllDatabases(void);
266 
267  template<typename T> static T readSharedResource(T *resource,
268  QReadWriteLock &mutex)
269  {
270  QReadLocker locker(&mutex);
271  T value = T();
272 
273  if(resource)
274  value = *resource;
275 
276  return value;
277  }
278 
279  template<typename T> static void setSharedResource(T *resource,
280  const T &value,
281  QReadWriteLock &mutex)
282  {
283  QWriteLocker locker(&mutex);
284 
285  if(resource)
286  *resource = value;
287  }
288 
289  private:
290  static QAtomicInt s_enableLog;
291  static QReadWriteLock s_dbMutex;
292  static quint64 s_dbId;
293  spoton_misc(void);
294 };
295 
296 #endif
spoton_misc
Definition: spot-on-misc.h:72
spoton_type_punning_sockaddr
Definition: spot-on-misc.h:60
spoton_crypt
Definition: spot-on-crypt.h:64